home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / cgesvx.z / cgesvx
Text File  |  1996-03-14  |  13KB  |  331 lines
  1.  
  2.  
  3.  
  4. CCCCGGGGEEEESSSSVVVVXXXX((((3333FFFF))))                                                          CCCCGGGGEEEESSSSVVVVXXXX((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CGESVX - use the LU factorization to compute the solution to a complex
  10.      system of linear equations  A * X = B,
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CGESVX( FACT, TRANS, N, NRHS, A, LDA, AF, LDAF, IPIV, EQUED,
  14.                         R, C, B, LDB, X, LDX, RCOND, FERR, BERR, WORK, RWORK,
  15.                         INFO )
  16.  
  17.          CHARACTER      EQUED, FACT, TRANS
  18.  
  19.          INTEGER        INFO, LDA, LDAF, LDB, LDX, N, NRHS
  20.  
  21.          REAL           RCOND
  22.  
  23.          INTEGER        IPIV( * )
  24.  
  25.          REAL           BERR( * ), C( * ), FERR( * ), R( * ), RWORK( * )
  26.  
  27.          COMPLEX        A( LDA, * ), AF( LDAF, * ), B( LDB, * ), WORK( * ), X(
  28.                         LDX, * )
  29.  
  30. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  31.      CGESVX uses the LU factorization to compute the solution to a complex
  32.      system of linear equations
  33.         A * X = B, where A is an N-by-N matrix and X and B are N-by-NRHS
  34.      matrices.
  35.  
  36.      Error bounds on the solution and a condition estimate are also provided.
  37.  
  38.  
  39. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  40.      The following steps are performed:
  41.  
  42.      1. If FACT = 'E', real scaling factors are computed to equilibrate
  43.         the system:
  44.            TRANS = 'N':  diag(R)*A*diag(C)     *inv(diag(C))*X = diag(R)*B
  45.            TRANS = 'T': (diag(R)*A*diag(C))**T *inv(diag(R))*X = diag(C)*B
  46.            TRANS = 'C': (diag(R)*A*diag(C))**H *inv(diag(R))*X = diag(C)*B
  47.         Whether or not the system will be equilibrated depends on the
  48.         scaling of the matrix A, but if equilibration is used, A is
  49.         overwritten by diag(R)*A*diag(C) and B by diag(R)*B (if TRANS='N')
  50.         or diag(C)*B (if TRANS = 'T' or 'C').
  51.  
  52.      2. If FACT = 'N' or 'E', the LU decomposition is used to factor the
  53.         matrix A (after equilibration if FACT = 'E') as
  54.            A = P * L * U,
  55.         where P is a permutation matrix, L is a unit lower triangular
  56.         matrix, and U is upper triangular.
  57.  
  58.      3. The factored form of A is used to estimate the condition number
  59.         of the matrix A.  If the reciprocal of the condition number is
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCGGGGEEEESSSSVVVVXXXX((((3333FFFF))))                                                          CCCCGGGGEEEESSSSVVVVXXXX((((3333FFFF))))
  71.  
  72.  
  73.  
  74.         less than machine precision, steps 4-6 are skipped.
  75.  
  76.      4. The system of equations is solved for X using the factored form
  77.         of A.
  78.  
  79.      5. Iterative refinement is applied to improve the computed solution
  80.         matrix and calculate error bounds and backward error estimates
  81.         for it.
  82.  
  83.      6. If equilibration was used, the matrix X is premultiplied by
  84.         diag(C) (if TRANS = 'N') or diag(R) (if TRANS = 'T' or 'C') so
  85.         that it solves the original system before equilibration.
  86.  
  87.  
  88. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  89.      FACT    (input) CHARACTER*1
  90.              Specifies whether or not the factored form of the matrix A is
  91.              supplied on entry, and if not, whether the matrix A should be
  92.              equilibrated before it is factored.  = 'F':  On entry, AF and
  93.              IPIV contain the factored form of A.  If EQUED is not 'N', the
  94.              matrix A has been equilibrated with scaling factors given by R
  95.              and C.  A, AF, and IPIV are not modified.  = 'N':  The matrix A
  96.              will be copied to AF and factored.
  97.              = 'E':  The matrix A will be equilibrated if necessary, then
  98.              copied to AF and factored.
  99.  
  100.      TRANS   (input) CHARACTER*1
  101.              Specifies the form of the system of equations:
  102.              = 'N':  A * X = B     (No transpose)
  103.              = 'T':  A**T * X = B  (Transpose)
  104.              = 'C':  A**H * X = B  (Conjugate transpose)
  105.  
  106.      N       (input) INTEGER
  107.              The number of linear equations, i.e., the order of the matrix A.
  108.              N >= 0.
  109.  
  110.      NRHS    (input) INTEGER
  111.              The number of right hand sides, i.e., the number of columns of
  112.              the matrices B and X.  NRHS >= 0.
  113.  
  114.      A       (input/output) COMPLEX array, dimension (LDA,N)
  115.              On entry, the N-by-N matrix A.  If FACT = 'F' and EQUED is not
  116.              'N', then A must have been equilibrated by the scaling factors in
  117.              R and/or C.  A is not modified if FACT = 'F' or
  118.  
  119.              On exit, if EQUED .ne. 'N', A is scaled as follows:  EQUED = 'R':
  120.              A := diag(R) * A
  121.              EQUED = 'C':  A := A * diag(C)
  122.              EQUED = 'B':  A := diag(R) * A * diag(C).
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCGGGGEEEESSSSVVVVXXXX((((3333FFFF))))                                                          CCCCGGGGEEEESSSSVVVVXXXX((((3333FFFF))))
  137.  
  138.  
  139.  
  140.      LDA     (input) INTEGER
  141.              The leading dimension of the array A.  LDA >= max(1,N).
  142.  
  143.      AF      (input or output) COMPLEX array, dimension (LDAF,N)
  144.              If FACT = 'F', then AF is an input argument and on entry contains
  145.              the factors L and U from the factorization A = P*L*U as computed
  146.              by CGETRF.  If EQUED .ne. 'N', then AF is the factored form of
  147.              the equilibrated matrix A.
  148.  
  149.              If FACT = 'N', then AF is an output argument and on exit returns
  150.              the factors L and U from the factorization A = P*L*U of the
  151.              original matrix A.
  152.  
  153.              If FACT = 'E', then AF is an output argument and on exit returns
  154.              the factors L and U from the factorization A = P*L*U of the
  155.              equilibrated matrix A (see the description of A for the form of
  156.              the equilibrated matrix).
  157.  
  158.      LDAF    (input) INTEGER
  159.              The leading dimension of the array AF.  LDAF >= max(1,N).
  160.  
  161.      IPIV    (input or output) INTEGER array, dimension (N)
  162.              If FACT = 'F', then IPIV is an input argument and on entry
  163.              contains the pivot indices from the factorization A = P*L*U as
  164.              computed by CGETRF; row i of the matrix was interchanged with row
  165.              IPIV(i).
  166.  
  167.              If FACT = 'N', then IPIV is an output argument and on exit
  168.              contains the pivot indices from the factorization A = P*L*U of
  169.              the original matrix A.
  170.  
  171.              If FACT = 'E', then IPIV is an output argument and on exit
  172.              contains the pivot indices from the factorization A = P*L*U of
  173.              the equilibrated matrix A.
  174.  
  175.      EQUED   (input or output) CHARACTER*1
  176.              Specifies the form of equilibration that was done.  = 'N':  No
  177.              equilibration (always true if FACT = 'N').
  178.              = 'R':  Row equilibration, i.e., A has been premultiplied by
  179.              diag(R).  = 'C':  Column equilibration, i.e., A has been
  180.              postmultiplied by diag(C).  = 'B':  Both row and column
  181.              equilibration, i.e., A has been replaced by diag(R) * A *
  182.              diag(C).  EQUED is an input argument if FACT = 'F'; otherwise, it
  183.              is an output argument.
  184.  
  185.      R       (input or output) REAL array, dimension (N)
  186.              The row scale factors for A.  If EQUED = 'R' or 'B', A is
  187.              multiplied on the left by diag(R); if EQUED = 'N' or 'C', R is
  188.              not accessed.  R is an input argument if FACT = 'F'; otherwise, R
  189.              is an output argument.  If FACT = 'F' and EQUED = 'R' or 'B',
  190.              each element of R must be positive.
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. CCCCGGGGEEEESSSSVVVVXXXX((((3333FFFF))))                                                          CCCCGGGGEEEESSSSVVVVXXXX((((3333FFFF))))
  203.  
  204.  
  205.  
  206.      C       (input or output) REAL array, dimension (N)
  207.              The column scale factors for A.  If EQUED = 'C' or 'B', A is
  208.              multiplied on the right by diag(C); if EQUED = 'N' or 'R', C is
  209.              not accessed.  C is an input argument if FACT = 'F'; otherwise, C
  210.              is an output argument.  If FACT = 'F' and EQUED = 'C' or 'B',
  211.              each element of C must be positive.
  212.  
  213.      B       (input/output) COMPLEX array, dimension (LDB,NRHS)
  214.              On entry, the N-by-NRHS right hand side matrix B.  On exit, if
  215.              EQUED = 'N', B is not modified; if TRANS = 'N' and EQUED = 'R' or
  216.              'B', B is overwritten by diag(R)*B; if TRANS = 'T' or 'C' and
  217.              EQUED = 'C' or 'B', B is overwritten by diag(C)*B.
  218.  
  219.      LDB     (input) INTEGER
  220.              The leading dimension of the array B.  LDB >= max(1,N).
  221.  
  222.      X       (output) COMPLEX array, dimension (LDX,NRHS)
  223.              If INFO = 0, the N-by-NRHS solution matrix X to the original
  224.              system of equations.  Note that A and B are modified on exit if
  225.              EQUED .ne. 'N', and the solution to the equilibrated system is
  226.              inv(diag(C))*X if TRANS = 'N' and EQUED = 'C' or or 'B'.
  227.  
  228.      LDX     (input) INTEGER
  229.              The leading dimension of the array X.  LDX >= max(1,N).
  230.  
  231.      RCOND   (output) REAL
  232.              The estimate of the reciprocal condition number of the matrix A
  233.              after equilibration (if done).  If RCOND is less than the machine
  234.              precision (in particular, if RCOND = 0), the matrix is singular
  235.              to working precision.  This condition is indicated by a return
  236.              code of INFO > 0, and the solution and error bounds are not
  237.              computed.
  238.  
  239.      FERR    (output) REAL array, dimension (NRHS)
  240.              The estimated forward error bound for each solution vector X(j)
  241.              (the j-th column of the solution matrix X).  If XTRUE is the true
  242.              solution corresponding to X(j), FERR(j) is an estimated upper
  243.              bound for the magnitude of the largest element in (X(j) - XTRUE)
  244.              divided by the magnitude of the largest element in X(j).  The
  245.              estimate is as reliable as the estimate for RCOND, and is almost
  246.              always a slight overestimate of the true error.
  247.  
  248.      BERR    (output) REAL array, dimension (NRHS)
  249.              The componentwise relative backward error of each solution vector
  250.              X(j) (i.e., the smallest relative change in any element of A or B
  251.              that makes X(j) an exact solution).
  252.  
  253.      WORK    (workspace) COMPLEX array, dimension (2*N)
  254.  
  255.      RWORK   (workspace/output) REAL array, dimension (2*N)
  256.              On exit, RWORK(1) contains the reciprocal pivot growth factor
  257.              norm(A)/norm(U). The "max absolute element" norm is used. If
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. CCCCGGGGEEEESSSSVVVVXXXX((((3333FFFF))))                                                          CCCCGGGGEEEESSSSVVVVXXXX((((3333FFFF))))
  269.  
  270.  
  271.  
  272.              RWORK(1) is much less than 1, then the stability of the LU
  273.              factorization of the (equilibrated) matrix A could be poor. This
  274.              also means that the solution X, condition estimator RCOND, and
  275.              forward error bound FERR could be unreliable. If factorization
  276.              fails with 0<INFO<=N, then RWORK(1) contains the reciprocal pivot
  277.              growth factor for the leading INFO columns of A.
  278.  
  279.      INFO    (output) INTEGER
  280.              = 0:  successful exit
  281.              < 0:  if INFO = -i, the i-th argument had an illegal value
  282.              > 0:  if INFO = i, and i is
  283.              <= N:  U(i,i) is exactly zero.  The factorization has been
  284.              completed, but the factor U is exactly singular, so the solution
  285.              and error bounds could not be computed.  = N+1: RCOND is less
  286.              than machine precision.  The factorization has been completed,
  287.              but the matrix is singular to working precision, and the solution
  288.              and error bounds have not been computed.
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.